home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / edit / la002.zip / CBX266.EXE / BBF.DOC < prev    next >
Text File  |  1987-06-11  |  12KB  |  370 lines
  1.                      ██████████
  2.                    ██████████████
  3.                   ███ · ████ · ███
  4.                    ██████████████
  5.                    ██████  ██████
  6.                     ████████████
  7.                       ████████
  8.                      ██││││││██
  9.                       ████████
  10.                   ██▄          ▄██
  11.                    ▀██▄      ▄██▀
  12.                      ▀██▄  ▄██▀
  13.                        ▀████▀
  14.                        ▄████▄
  15.                      ▄██▀  ▀██▄
  16.                    ▄██▀      ▀██▄
  17.                   ██▀          ▀██
  18.  
  19.                    ┌────────────┐
  20.                    │ BLACKBEARD │
  21.                    └────────────┘
  22.  
  23.                    User Supported Software
  24.  
  25.  
  26.                     VERSION LOG
  27.                    BLACKBEARD FORMATTER
  28.  
  29.      version  remarks
  30.      ------------------------------------------------------------------
  31.      2.5      New C compiler. Fixed .bold bug introduce with verison 2.4
  32.           Spacing added (Double, Triple, etc.)
  33.  
  34.      2.4      Added underlining capability feature
  35.  
  36.      2.3      C compiler compatible version. 3-87
  37.  
  38.      2.2      Latest BB 6.45 distribution version.  2-9-87.
  39.           Multi-line footer commands
  40.  
  41.      2.1      Bold start & end sequences added.
  42.  
  43.      2.0      New C Compiler used. Output command added.
  44.  
  45.      1.7      Bold function to insert special bold sequences
  46.  
  47.      1.6      Require function added to allow merging of files.
  48.  
  49.      1.5      Title does not skip spaces when using multi-line titles.
  50.  
  51.      1.4      File terminated with FF CR LF
  52.  
  53.      1.3      Fixed bug that truncated first line to the length of the
  54.           title.
  55.  
  56.      1.2      Multi-line titles (upto 10)
  57.  
  58.      1.1      Added sections and table of contents feature and include
  59.           file.
  60.  
  61.      1.0      First release version of the formatter.
  62.  
  63.      INTRODUCTION
  64.  
  65.         Printing out documents is an essential associated task of a
  66.      text processing system. Blackbeard performs the editing tasks
  67.      very well. An available text formatter/printer was not
  68.      available. Programs like Microsoft Word (R) are so word
  69.      processing oriented that simplicity is often compromised. The
  70.      Blackbeard formatter is a simple to use, do what I tell you, text
  71.      processor.  It takes any text file and produce a cleaned up
  72.      printed output.  It is also a powerful formatter for producing
  73.      technical documents.  A design constraint was that the initial
  74.      version be compatible with DEC's DSR (R) as much as possible.
  75.  
  76.         This manual describes how to use the formatter.
  77.  
  78.      RUNNING BLACKBEARD FORMATTER
  79.  
  80.         To run Blackbeard formatter type:
  81.  
  82.            BBF
  83.  
  84.         or
  85.  
  86.            BBF {filename}
  87.  
  88.         BBF does not include a pop-up directory of files to format
  89.      yet (available real soon now). BBF will then format your
  90.      document and write it to the standard output device (the
  91.      screen). To send the output to the printer run Blackbeard with
  92.      the command:
  93.  
  94.            BBF {filename} >prn
  95.  
  96.         This redirects output to the printer. You could also
  97.      redirect the output to a filename if you want by substituting a
  98.      filename for prn.
  99.  
  100.      The default format is to print 2 blank lines at the top of the
  101.      page, the filename (used for the title), 2 more blank lines,
  102.      text lines as they appear in the file (no formatting is done,
  103.      except for tabs are converted to spaces, fonts are replaced if
  104.      enabled and spaces are insert if a left margin is used), 2 blank
  105.      lines, a page number, and a form feed.
  106.  
  107.      COMMANDS
  108.  
  109.         The nature of the format can be altered by embedding
  110.      formatter commands (often known as dot commands) in your text.
  111.      The general format is:
  112.  
  113.      .command parameter1 parameter2 text
  114.  
  115.      The following is a description of the available commands.
  116.  
  117.      .bold c string
  118.         Sets up a bold charater indicator.  When the bold
  119.         character is first encountered in the text, all subsequent
  120.         characters are duplicated and the string is inserted between
  121.         the duplicated characters until a terminating bold character
  122.         is encountered.  Example:
  123.  
  124.         .bold @ &a+
  125.         abc@def@ghi
  126.  
  127.         formats to:
  128.  
  129.         abcd&a+de&a+ef&a+fghi
  130.  
  131.      .bs c string
  132.      .be c string
  133.         Sets up a bold charater indicator.  When the bold character is
  134.         first encountered in the text, all subsequent characters are
  135.         duplicated and the string designated with .bs is inserted
  136.         between the duplicated characters and the string designated
  137.         with .be is inserted after the duplicated character until a
  138.         terminating bold character is encountered.  Example:
  139.  
  140.      .bs  &a-67H
  141.      .be  &a-5H
  142.  
  143.      is the sequence to perform bolding on the HP Laserjet+ with the
  144.      standard 10CPI font. For:
  145.  
  146.         XYZ
  147.  
  148.         the string:
  149.  
  150.         X&a-67HX&a-5HY&a-67HY&a-5HZ&a-67HZ&a-5H
  151.  
  152.         is produced.  The HP laserjet+ perform the following
  153.      operations when receiving this sequence.  An X is printed then
  154.      the jet is moved "horizontally backward" 67 decipoints (i.e.,
  155.      just less than the character width of 72 decipoints), the
  156.      character X is printed again, and the jet is moved "horizontally
  157.      backward" 5 decipoints, which is the compensation for not having
  158.      moved back 72 originally.  So the character appears bold having
  159.      been printed once and the offset printed again.
  160.         This formatting command can cause your document to become
  161.      uneditable since lines can get very long.  Essentially each
  162.      bolded charater becomes equivalent to 15 characters (in this
  163.      example).  So if you have a line of 20 bolded characters, that
  164.      line is now 300 characters long! The max line length the
  165.      Blackbeard formatter can currently accomodate is 4096
  166.      characters.  So for this example that is a line of 273
  167.      characters.
  168.  
  169.      .dump string
  170.         Dumps a string to the file designated by the file command.
  171.  
  172.      .enable c
  173.         Set the font character as the character c. For example:
  174.  
  175.         .enable 
  176.  
  177.      .file filename
  178.         This command causes the formatter to place all header numbers
  179.         and titles in the specified file.  This functions as a table
  180.         of contents.
  181.  
  182.      .fm before-title after-title before-footer after-footer
  183.         Specify the page layout:
  184.  
  185.        ┌─────────────────────────────────┐
  186.        │        before-title            │
  187.        │    Title line                   │
  188.        │       after-title              │
  189.        │    This is a sample text line.  │
  190.        │    This is a sample text line.  │
  191.        │<-> This is a sample text line.  │
  192.        │lm  This is a sample text line.  │
  193.        │    This is a sample text line.  │
  194.        │    This is a sample text line.  │
  195.        │    This is a sample text line.  │
  196.        │    This is a sample text line.  │
  197.        │    This is a sample text line.  │
  198.        │    This is a sample text line.  │
  199.        │    This is a sample text line.  │
  200.        │    This is a sample text line.  │
  201.        │       before-footer            │
  202.        │    Footer line                  │
  203.        │       after-footer             │
  204.        └─────────────────────────────────┘
  205.  
  206.        The number of blank spaces at the top and bottom of the text.
  207.      Default is 2 2 2 2.
  208.  
  209.      .fo [n] text
  210.         Running footer at the bottom of page.  A # in the footer text
  211.         represents the page number.  Multiple line footers can be
  212.         designated by preceding the footer with a number between 0 and
  213.         9.  For example to get a two line footer use the commands:
  214.  
  215.         .fo 0 First footer line
  216.         .fo 1 Second footer line
  217.  
  218.         To create a blank header line you must set "display tabs" on
  219.         in Blackbeard (using the options menu) and put a few spaces
  220.         after the .fo command. This tells BBF that you still want
  221.         the header but that it is clear. This anomoly will be
  222.         changed in version 2.3 when it becomes available.
  223.  
  224.      .hl n
  225.         This is the header level command. It allows you to create
  226.         relocatable sections and produce automatic numbering like
  227.         1.2.4.6.
  228.  
  229.         Example:
  230.  
  231.         .hl 1 Section 1
  232.         .hl 2 Section 1.1
  233.         .hl 3 Section 1.1.1
  234.         .hl 2 Section 1.2
  235.         .hl 1 Section 2
  236.  
  237.      .include filename
  238.         This will emplace a file -- as is -- in the file you are
  239.         currently formatting.  This command includes graphics as well
  240.         as ASCII files.
  241.  
  242.      .le
  243.         This is a list element. It allows you to create a numbered
  244.         list.
  245.  
  246.      .ls
  247.         List start. Starts (and ends) an itemized list.
  248.  
  249.      .lm n
  250.         Left margin. Default is 0.
  251.  
  252.      .nmlv header-level number
  253.